The HTML5 Viewer supports a list of parameters that are used to customize the user interface and specify the documents and annotations that should be loaded.
Configuration
|
Parameter |
Data Type |
Description |
|
documentID |
String |
Specifies the document to be loaded within the viewer. |
|
imageHandlerUrl |
String |
Specifies the location of the image handler. |
|
annotationID |
String |
Specifies the annotation file to be used within the viewer. |
|
resourcePath |
String |
The location of the toolbox icons within of the viewer. By default, this is set to the "Images" folder. Please note, the viewer also references background images used within the style sheet (pcc.css) that will also need to be updated in the event that the "Images" folder is renamed or moved. |
|
toolboxMenuOpen |
Boolean |
Whether the toolbox menu should be opened or closed when the viewer is initialized. |
uiElements
|
Parameter |
Data Type |
Description |
| defaultMouseTool | String | The default tool selected within the viewer. The options are: selectToZoom, panTool, magnifierTool and selectText. If no option is specified, the selectText tool will be the default. |
|
tooltips |
Boolean |
Enable or disable tooltips within the viewer. |
|
navigation |
Boolean |
Hide or show the navigation bar. |
| contextMenu | Boolean | Hide or show the contextMenu. |
|
firstLastPage |
Boolean |
Hide or show the First and Last page navigation buttons. |
|
nextPreviousPage |
Boolean |
Hide or show the Next and Previous page navigation buttons. |
|
toolboxMenu |
Boolean |
Hide or show the toolbox menu. |
|
zoomIn |
Boolean |
Hide or show the zoom-in button. |
|
zoomOut |
Boolean |
Hide or show the zoom-out button. |
| printing | Boolean | Hide or show the printing button. |
|
fullScreenToggle |
Boolean |
Hide or show the Full Screen toggle button. |
|
viewTab |
Boolean |
Hide or show the View Tab |
|
magnifierTool |
Boolean |
Hide or show the magnifier tool, located within the View Tab. |
|
selectToZoom |
Boolean |
Hide or show the select to zoom tool, located within the View Tab. |
|
panTool |
Boolean |
Hide or show the pan tool, located within the View Tab. |
|
rotateRight |
Boolean |
Hide or show the rotate right button, located within the View Tab. |
|
rotateLeft |
Boolean |
Hide or show the rotate left button, located within the View Tab. |
|
viewFullImage |
Boolean |
Hide or show the view full image button, located within the View Tab. |
|
fitToWidth |
Boolean |
Hide or show the fit to width button, located within the View Tab. |
|
fitToHeight |
Boolean |
Hide or show the fit to height button, located within the View Tab. |
|
viewActualSize |
Boolean |
Hide or show the view actual size button, located within the View Tab. |
|
thumbnailTab |
Boolean |
Hide or show the Thumbnail Tab. |
|
annotateRedactTab |
Boolean |
Hide or show the Annotate & Redact Tab. This requires a product license that supports annotation and/or redaction features. |
|
annotateTab |
Boolean |
Hide or show the Annotate Tab. If the annotateRedactTab is marked to false, this value will be overridden. This requires a product license that supports annotation features. |
|
redactTab |
Boolean |
Hide or show the Redact Tab. This requires a product license that supports redaction features. |
|
saveLoadAnnotations |
Boolean |
Hide or show the save and load functionality for annotations and redactions. |
|
arrowAnnotation |
Boolean |
Hide or show the arrow annotation button, located within the Annotate Tab. |
|
lineAnnotation |
Boolean |
Hide or show the line annotation button, located within the Annotate Tab. |
|
rectangleAnnotation |
Boolean |
Hide or show the rectangle annotation button, located within the Annotate Tab. |
| transparentAnnotation | Boolean | Hide or show the transparent annotation button, located within the Annotate Tab. |
|
ellipseAnnotation |
Boolean |
Hide or show the ellipse annotation button, located within the Annotate Tab. |
|
editMarks |
Boolean |
Hide or show the edit marks button, located within the Annotate and Redact Tabs. |
|
deleteMarks |
Boolean |
Hide or show the delete marks button, located within the Annotate and Redact Tabs. |
|
textAnnotation |
Boolean |
Hide or show the text annotation button, located within the Annotate and Redact Tabs. |
|
rectangleRedaction |
Boolean |
Hide or show the rectangle redaction button, located within the Redact Tab. |
|
transparentRedaction |
Boolean |
Hide or show the transparent redaction button, located within the Redact Tab. |
|
textRedaction |
Boolean |
Hide or show the text redaction button, located within the Redact Tab. |
| arrowColor | String | Specifies the Hexadecimal color code for the arrow annotation. By default, the color is: #FB0404. |
| lineColor | String | Specifies the Hexadecimal color for the line annotation. By default, the color is: #18385F. |
| rectangleColor | String | Specifies the Hexadecimal color for the rectangle annotation. By default, the color is: #FB0404. |
| transparentColor | String | Specifies the Hexadecimal color for the transparent annotation. By default, the color is: #FFFF00. |
| ellipseColor | String | Specifies the Hexadecimal color for the ellipse annotation. By default, the color is: #FB0404. |
| textColor | String | Specifies the Hexadecimal color for the ellipse annotation. By default, the color is: #000000. |
